home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1996 April / Software of the Month Club 1996 April.iso / pc / os2 / htmlchk / readme.doc < prev   
Encoding:
Text File  |  1996-02-21  |  13.4 KB  |  378 lines
  1. HTML Check  (Version 1.02 Nov 14, 1995)
  2.  
  3. Changes:
  4. --------
  5. 1.00 Initial release
  6.  
  7. 1.01 -
  8.   - Fixed bad HTML check, won't Trap out on bad HTML
  9.   - Fixed the Physical path name on CGI-BIN files, and # references
  10.   - Added a buffer size 'MemAlloc=' in the INI file for increasing the
  11.     amount of memory available to the link list of Directories & HTML files
  12.   - Changed the Calls to the REXX function from MacroSpace to Disk call
  13.     (I couldn't get the MacroSpace cleaned up if there was an error in the
  14.     REXX macro)
  15.   - Display the Error messages to the Error list on the main display
  16.   - Removed the requirement of calling hcLoadVars - Do not call this
  17.     routine anymore it will display an error if you do.  Just delete it
  18.     all the of the REXX variable will be defined automagicaly for you.
  19.  
  20. 1.02 -
  21.   - Major Memory screw up!!! (Fixed)
  22.  
  23. 1.03
  24.   - Fixed yet another memory problem
  25.   - Added support for BODY - BACKGROUND Tag
  26.   - Read REXX routines into memory for faster running
  27.  
  28.  
  29. Andy Wysocki
  30. 3109 Village Rd West
  31. Norwood, MA 02062-2542
  32. awysocki@bearsoft.com
  33. http://www.bearsoft.com/abs/htmlchk.html
  34. -or-
  35. http://www.bearsoft.com/abs/abs_soft.html
  36.  
  37.  
  38.   HTMLChk was written because one day I found out that I was missing
  39. a bunch of .GIF files from the HTTP server.  I only came across it
  40. when I looked at the ERROR.LOG file to see that the files were missing
  41. for the past 10 days.  The ERROR.LOG file would do a good enough job
  42. for finding missing files, but when you move files or change HTML you
  43. don't always want to BROWSE all the pages you just moved/changed.  This
  44. is where HTMLChk will do the work for you and produce a report with the
  45. information you need.
  46.  
  47.   I am open to all Suggestions and Ideas as to the functionality of
  48. HTMLChk.  So PLEASE feel free to submit your problems & suggestions.
  49.  
  50. REGISTRATION:
  51.   In version 1.01 there is no checking of being a registered user,  After
  52. a couple of version I will be putting in a REGISTERED CHECK!!  So for now
  53. enjoy, To register it will cost $20.00 USD  make all checks payable to
  54.  
  55. AB Software
  56. 3109 Village Rd West
  57. Norwood, MA 02062
  58.  
  59.  
  60. INSTALLATION:
  61.  
  62.   To install HTMLChk you probably already UNZIPed the file into a directory
  63. and are reading this README file.  If you did it with the proper options
  64. (no specific options for OS/2, '-do' for DOS) you should have two directories
  65. that were created under the directory the files were UNZIPed into.  They are
  66. the MAC and RPT directories.  Assuming you created a directory called
  67. \HTMLCHK,  the UNZIP should have created \HTMLCHK\MAC and \HTMLCHK\RPT.
  68. If not make the two directories under your directory and 'MOVE *.MAC MAC' to
  69. the MAC directory.
  70.  
  71.  
  72. DESKTOP:
  73.  
  74.   I have included a small REXX program to create an DESKTOP Object.  You can
  75. run the MAKEWPS.CMD file to create a desktop object.  NOTE:  You must run
  76. this .CMD file from the directory where the files were installed.  ie: if
  77. you installed the programs in the HTMLCHK directory, then you must be in
  78. that directory to run the MAKEWPS.CMD file.  After you create the object
  79. I recommend that you open up the setting on the object and add the default
  80. path to it.
  81.  
  82.  
  83. cd \htmlchk
  84. makewps
  85.  
  86.  
  87. CUSTOMIZING:
  88.  
  89.   There are a couple of files you can customize to make HTMLCHK work better
  90. for you.  The HTMLCHK.INI file and the .MAC files.
  91.  
  92.  
  93. HTMLCHK.INI
  94.  
  95.   Below I will describe the Keyword that can be defined in the HTMLCHK.INI
  96. file.  The keywords can be any case (mixed, lower, upper).  All the
  97. basic INI stuff is kept under the [HTMLCheck] heading.  An example INI
  98. file would be as follows, excluding the six -'s
  99. ------
  100. [HTMLCheck]
  101.   Debug=Off
  102.   ServerURL=http://www.bearsoft.com
  103.   ServerRoot=d:\os2httpd
  104.   DocumentRoot=d:\os2httpd\docs
  105.  
  106.   ReportDefault=1
  107.   ReportDesc1=Standard Report
  108.   ReportKey1=hcStandard
  109.  
  110. [hcStandard]
  111.   hcInit=mac\hcinit.mac
  112.   hcSSec=mac\hcssec.mac
  113.   hcLine=mac\hcline.mac
  114.   hcESec=mac\hcesec.mac
  115.   hcTerm=mac\hcTerm.mac
  116.   Report=rpt\htmlchk.rpt
  117. ------
  118.  
  119.  
  120. Debug=
  121.         Can be set to ON or OFF,  Will turn on debug tracing to the HTMLCHK.DBG
  122.         file.  No real information is kept here so for normal runs keep this
  123.         set to OFF.
  124.         The default = OFF
  125.  
  126. ServerRoot=
  127.         This is the Drive and Subdirectory of the Server ROOT directory.
  128.         For OS2HTTPD this would be D:\OS2HTTPD (with the drive letter
  129.         changing for the drive its on)
  130.         The default = C:\OS2HTTPD
  131.  
  132. ServerURL=
  133.         This is the URL for your server (root).  This is used when parsing
  134.         the HTML if its matched it will assume the file is LOCAL and verify
  135.         that it exsists.  Currently only 1 ServerURL is supported.
  136.         The default = HTTP://
  137.  
  138. DocumentRoot=
  139.         This is the drive and subdirectory of where the docuements start.
  140.         This is usually C:\OS2HTTPD\DOCS.
  141.         The default = C:\OS2HTTPD\DOCS
  142.  
  143. TopHTML=
  144.         This is the Top HTML file that the server will send to the client
  145.         when the server is hit from the top.
  146.         The default = INDEX.HTML
  147.  
  148. IndexTypes=
  149.         This is the list of valid HTML names if a client give an URL of
  150.         just the directory.  The server will normally look for INDEX.HTML
  151.         and send it back to the user.  This list should contain the same
  152.         list that the server would use.  The file names are separated by
  153.         commas and HAVE NO BLANKS between.  Some other files could be
  154.         index.shtml,index.sht,index.htm,index.html
  155.         The default = index.html,index.htm
  156.  
  157. HTMLTypes=
  158.         This is the list of valid HTML extensions to determine what files
  159.         are to be treated at HTML files.   This list should contain the list
  160.         of extensions of the HTML files separated by commas with no blank
  161.         inbetween the list.
  162.         The default = .html,.htm
  163.  
  164. OffRoot=
  165.         This is the list of valid Server Root directories that the HTTP Server
  166.         can access.
  167.         The default = /ICONS/,/CGI-BIN/
  168.  
  169. IgnoreDir=
  170.         This is a list of Dirve:/Paths to ignore when gathering the information
  171.         If you have a directory that you are working in and you don't want
  172.         to scan it, enter the Drive:Path of the directories you want to skip.
  173.         REMEMBER separate by commas and NOT EXTRA BLANKS.  Use IgnorePrint
  174.         if some of the files in a directory are accessed by HTML but you
  175.         don't want a report on the directory.
  176.         ie:IgnorePrint=C:\OS2HTTPD\DOCS\NCSA,C:\OS2HTTPD\DOCS\TEST
  177.         The default =
  178.  
  179. IgnorePrint=
  180.         This is the list of Dirve:/Paths to ignore when sending stuff to the
  181.         REXX Macros.  If you have a directory that you are working in and
  182.         you don't want to enter into the reports. Enter the Drive:Path of
  183.         the directories you want to skip. REMEMBER separate by commas and
  184.         NOT EXTRA BLANKS
  185.         ie:IgnorePrint=C:\OS2HTTPD\DOCS\NCSA,C:\OS2HTTPD\DOCS\TEST
  186.         The default =
  187.  
  188. Browser=
  189.         This is the editor or browser to call up when the Browse report
  190.         button is pressed on the main screen.
  191.         The default = c:\os2\e.exe
  192.  
  193. ReportDefault=
  194.         This is the default report to select when the program is first
  195.         run.  It should be any number between 1 and the max number of
  196.         reports defined.
  197.         The default = 1
  198.  
  199. ReportDesc_=
  200.         This is the report description for report number '_' where the _
  201.         is any valid sequential number.  The number must start with 1 and
  202.         proceed upward.  With each ReportDesc_ defined you must supply a
  203.         ReportKey_ keyword too.
  204.         The default = (none set)
  205.  
  206. ReportKey_=
  207.         This is the Keyword that is associated with the report.  When
  208.         HTMLChk runs the report it will use this KeyWord as the heading
  209.         to searh for.
  210.         The default = (none set)
  211.  
  212.  
  213. MemAlloc=
  214.         This is the number of 4K block of memory to allocate for the
  215.         directory tree.  The default is 256 (1Meg).  You should only have to
  216.         set this bigger if you have a big directory tree, or long
  217.         path names.
  218.         The default = 256
  219.  
  220. ----------------
  221. These keywords have to be defined under a ReportKey HEADING (see sample)
  222. None of these keys have a default!
  223.  
  224. hcInit=
  225.         The Macro/Rexx file called at the start of a report
  226.  
  227. hcSSec=
  228.         The Macro/Rexx file called at the beginning of a new directory
  229.         or the start of an HTML file.
  230.  
  231. hcLine=
  232.         The Macro/Rexx file called for EACH line to be processed.
  233.  
  234. hcESec=
  235.         The Macro/Rexx file called at the end of a directory
  236.         or the end of an HTML file.
  237.  
  238. hcTerm=
  239.         The Macro/Rexx file called at the end of a report
  240.  
  241. Report=
  242.         The report file to use for output
  243.  
  244.  
  245. MACRO VARIABLES & FUNCTIONS:
  246.  
  247.   I have included REXX as the program language of choice for buiding the
  248. reports.  There are 5 REXX/MAC macros that the program will call when
  249. generating the reports.  They are INIT, SSEC, LINE, ESEC and TERM.
  250.  
  251.   See the INI file descriptions for when/where/why these macros are called.
  252.  
  253. This chart will show when these variables are valid and what REXX/MAC
  254. can use them.
  255.  
  256.                                         Init  SSec  Line  ESec  Term
  257. ---------------------------------------------------------------------
  258. hcReportName                             X                       X
  259. hcReportDescription                      X                       X
  260. hcServerURL                              X                       X
  261. hcServerRoot                             X                       X
  262. hcDocumentRoot                           X                       X
  263. hcTopHTML                                X                       X
  264. hcDeep                                          X    X     X
  265. hcTotalBytes                                               X
  266. hclDoc                                          X    X
  267. hclPhysical                                     X    X
  268. hclFileSize                                     X    X
  269. hclHTMLTag                                      X    X
  270. hclFileType                                     X    X
  271. hclMatched                                      X    X
  272. hclLocalFound                                   X    X
  273. hclServerRoot                                   X    X
  274. hclOffSite                                      X    X
  275. hclParent                                       X    X
  276. hclAccessCount                                  X    X
  277. hcpDoc                                          X    X
  278. hcpPhysical                                     X    X
  279. hcpFileSize                                     X    X
  280. hcpHTMLTag                                      X    X
  281. hcpFileType                                     X    X
  282. hcpMatched                                      X    X
  283. hcpLocalFound                                   X    X
  284. hcpServerRoot                                   X    X
  285. hcpOffSite                                      X    X
  286. hcpAccessCount                                  X    X
  287.  
  288.  
  289. REXX/MAC VARIABLE DESCRIPTIONS:
  290.  
  291. hcReportName
  292.         - The Report Name file as defined by the REPORT INI Variable
  293.  
  294. hcReportDescription
  295.         - The report description as defined by the ReportDescription
  296.           INI variable
  297.  
  298. hcServerURL
  299.         - The Server URL as defined by the ServerURL INI Variable
  300.  
  301. hcServerRoot
  302.         - The Server Root Path as defined by the ServerRoot INI Variable
  303.  
  304. hcDocumentRoot
  305.         - The Document Root Path as defined by the DocumentRoot INI Variable
  306.  
  307. hcTopHTML
  308.         - The TOP HTML File name ss defined by the TopHTML INI Variable
  309.  
  310. hcDeep
  311.         - This variable is incremented every time it traverses a new
  312.           Directory or HTML file.  So looking at a PATH of
  313.           E:\DOCS\USERS\ANDY\INDEX.HTML  hcDeep would be = to 3 for the
  314.           Directory and 4 when it was parsing the HTML file.
  315.  
  316. hcTotalBytes
  317.         - The total number of bytes used by the files in a directory.
  318.  
  319. hclDoc
  320.         - The File name in the directory OR the HTML Tag Source
  321.  
  322. hclPhysical
  323.         - The Physical file name of the URL
  324.  
  325. hclFileSize
  326.         - The size of the file,  HTML tags will always be zero
  327.  
  328. hclHTMLTag
  329.         - The Type of HTML tag that was processed.  Valid Values are
  330.         A, IMG, HTML, LINK, FORM, ISINDEX
  331.  
  332. hclFileType
  333.         - The Type of file that was processed.  Valid Values are
  334.         HTML, DIRECTORY, OTHER, HTMLTAG
  335.  
  336. hclMatched
  337.         - Yes/No field to say if this file is accessed by an HTML tag.
  338.  
  339. hclLocalFound
  340.         - Yes/No field to say if the Physical file was found.
  341.  
  342. hclServerRoot
  343.         - Yes/No field to say this file is accessed from the Server Root
  344.  
  345. hclOffSite
  346.         - Yes/No field to say this HTML URL is referencing a file somewhere
  347.           other than this server.
  348.  
  349. hclParent
  350.         - Yes/No  field is the 'hcp...' variables are valid.  This will
  351.           be set to yes when inside an HTML file.
  352.  
  353. hclAccessCount
  354.         - This number has two meanings,  For a flat file it will always be
  355.         1, for a directory it should be the number of files in the directory.
  356.         for an HTML tag it will be the number of times inside the parent
  357.         document that this file is referenced.
  358.  
  359.  
  360. --The rest of these variables are the same as the 'hcl...' variables except
  361.   they reference the parent document!
  362.  
  363.       hcpDoc
  364.       hcpPhysical
  365.       hcpFileSize
  366.       hcpHTMLTag
  367.       hcpFileType
  368.       hcpMatched
  369.       hcpLocalFound
  370.       hcpServerRoot
  371.       hcpOffSite
  372.       hcpAccessCount
  373.  
  374.  
  375.  
  376.  
  377. --- Thats all folks --- End of Document ---
  378.